Update a campaign
Updates an existing advertising campaign and returns information about the updated campaign.
Access Control:
- Only the owner of the campaign can update it.
If you change the campaign to archived, the budget allocated to the campaign is returned.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Schema for updating campaign entity.
Bidding strategy for the campaign
highest_volume, bid_cap The datetime in RFC 3339 format when the campaign ends.
Campaign objective
click, reach, impression, conversion The name of the campaign.
The owner's ID of the campaign
The datetime in RFC 3339 format when the campaign starts. For example, 2017-07-21 17:32:28
Enum for campaign status.
okay, preparing, ready, archived The list of audience segments for targeting
The total budget of the campaign
The date and time the entity was created.
The description of the campaign
Maximum bid per impression (only available for 'maximize_volume' bid strategy)
x >= 0Internal purpose
x >= 1000The sub-goal of the campaign
Target cost per action
x >= 0Target cost per thousand impressions (only available for 'target_cpm' sub-goal)
x >= 0Guaranteed impressions within the campaign period (only available for 'target_volume' sub-goal)
x >= 0The date and time the entity was last updated.
Response
Successful Response
Schema representing a campaign entity with all its properties and metadata.
Bidding strategy for the campaign
highest_volume, bid_cap The datetime in RFC 3339 format when the campaign ends.
Campaign objective
click, reach, impression, conversion The name of the campaign.
The owner's ID of the campaign
The datetime in RFC 3339 format when the campaign starts. For example, 2017-07-21 17:32:28
Enum for campaign status.
okay, preparing, ready, archived The list of audience segments for targeting
The total budget of the campaign
The date and time the entity was created.
The description of the campaign
The id of the campaign
Maximum bid per impression (only available for 'maximize_volume' bid strategy)
x >= 0Internal purpose
x >= 1000The sub-goal of the campaign
Target cost per action
x >= 0Target cost per thousand impressions (only available for 'target_cpm' sub-goal)
x >= 0Guaranteed impressions within the campaign period (only available for 'target_volume' sub-goal)
x >= 0The date and time the entity was last updated.